Fix multi-search with template doesn't return status code by gaobinlong · Pull Request #16265 · opensearch-project/OpenSearch

gaobinlong · 2024-10-10T04:59:18Z

Description

Currently the multi-search API does return the status code in each search response, but multi-search template API does not, these two APIs are very similar, we should make the response consistent, so this PR adds a status code field in each search response for the multi-search template API.

Related Issues

#11133

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Gao Binlong <gbinlong@amazon.com>

github-actions · 2024-10-10T05:55:16Z

❌ Gradle check result for 8ecb0c9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

reta · 2024-10-11T18:18:31Z

Thanks @gaobinlong , we would need API changes [1] (and may be documentation updates if we have any) [2].

[1] https://github.com/opensearch-project/opensearch-api-specification
[2] https://github.com/opensearch-project/documentation-website/

reta · 2024-10-12T03:52:20Z

I see now the msearch api and msearch template api uses same response schema: MultiSearchResult, so may no need to change it?

Thanks @gaobinlong. I just briefly looked at it, seems like MultiSearchResult has no status property? Or I am missing something?

github-actions · 2024-10-12T04:51:31Z

❌ Gradle check result for 9778ed5: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

gaobinlong · 2024-10-12T05:14:32Z

I see now the msearch api and msearch template api uses same response schema: MultiSearchResult, so may no need to change it?

Thanks @gaobinlong. I just briefly looked at it, seems like MultiSearchResult has no status property? Or I am missing something?

status exists in each search response, the definition is here, the whole response of the API is like this:

{
  "took": 8,
  "responses": [
    {
      "took": 7,
      "timed_out": false,
      "_shards": {...},
      "hits": {...},
      "status": 200
    },
   {
      "took": 7,
      "timed_out": false,
      "_shards": {...},
      "hits": {...},
      "status": 200
    }
  ]
}

reta · 2024-10-12T14:22:33Z

I see now the msearch api and msearch template api uses same response schema: MultiSearchResult, so may no need to change it?

Thanks @gaobinlong. I just briefly looked at it, seems like MultiSearchResult has no status property? Or I am missing something?

status exists in each search response, the definition is here, the whole response of the API is like this:
{
  "took": 8,
  "responses": [
    {
      "took": 7,
      "timed_out": false,
      "_shards": {...},
      "hits": {...},
      "status": 200
    },
   {
      "took": 7,
      "timed_out": false,
      "_shards": {...},
      "hits": {...},
      "status": 200
    }
  ]
}

Perfrect, thank you!

github-actions · 2024-10-14T03:08:52Z

❌ Gradle check result for 9778ed5: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

dbwiddis · 2024-10-14T03:26:25Z

Flaky:

[AUTOCUT] Gradle Check Flaky Test Report for SpecificClusterManagerNodesIT #15944

github-actions · 2024-10-14T04:20:22Z

❌ Gradle check result for 9778ed5: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-10-14T05:26:10Z

✅ Gradle check result for 9778ed5: SUCCESS

codecov · 2024-10-14T05:26:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.07%. Comparing base (20536ee) to head (9778ed5).
Report is 3 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #16265      +/-   ##
============================================
+ Coverage     72.00%   72.07%   +0.06%     
- Complexity    64796    64828      +32     
============================================
  Files          5307     5307              
  Lines        302540   302544       +4     
  Branches      43708    43708              
============================================
+ Hits         217853   218052     +199     
+ Misses        66801    66646     -155     
+ Partials      17886    17846      -40

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

opensearch-trigger-bot · 2024-10-14T13:01:37Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-16265-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 55e98ed2735d898d884295c00f869f5f3278c222
# Push it to GitHub
git push --set-upstream origin backport/backport-16265-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-16265-to-2.x.

reta · 2024-10-14T13:03:24Z

@gaobinlong could you please backport to 2.x manually? thank you

…-project#16265) * Fix multi-search with template doesn't return status code Signed-off-by: Gao Binlong <gbinlong@amazon.com> * Modify changelog Signed-off-by: Gao Binlong <gbinlong@amazon.com> --------- Signed-off-by: Gao Binlong <gbinlong@amazon.com>

…ode (#16265) (#16312) * Fix multi-search with template doesn't return status code (#16265) * Fix multi-search with template doesn't return status code Signed-off-by: Gao Binlong <gbinlong@amazon.com> * Modify changelog Signed-off-by: Gao Binlong <gbinlong@amazon.com> --------- Signed-off-by: Gao Binlong <gbinlong@amazon.com> * Format the code Signed-off-by: Gao Binlong <gbinlong@amazon.com> --------- Signed-off-by: Gao Binlong <gbinlong@amazon.com>

…-project#16265) * Fix multi-search with template doesn't return status code Signed-off-by: Gao Binlong <gbinlong@amazon.com> * Modify changelog Signed-off-by: Gao Binlong <gbinlong@amazon.com> --------- Signed-off-by: Gao Binlong <gbinlong@amazon.com>

Fix multi-search with template doesn't return status code

c14fd41

Signed-off-by: Gao Binlong <gbinlong@amazon.com>

gaobinlong added the backport 2.x Backport to 2.x branch label Oct 10, 2024

Modify changelog

8ecb0c9

Signed-off-by: Gao Binlong <gbinlong@amazon.com>

opensearch-ci-bot mentioned this pull request Oct 10, 2024

[AUTOCUT] Gradle Check Flaky Test Report for AzureBlobStoreRepositoryTests #14291

Open

reta reviewed Oct 11, 2024

View reviewed changes

Comment thread modules/lang-mustache/src/main/java/org/opensearch/script/mustache/SearchTemplateResponse.java

reta approved these changes Oct 11, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into fix_multisearch

9778ed5

opensearch-ci-bot mentioned this pull request Oct 11, 2024

[AUTOCUT] Gradle Check Flaky Test Report for RemoteRestoreSnapshotIT #14324

Open

reta approved these changes Oct 12, 2024

View reviewed changes

opensearch-ci-bot mentioned this pull request Oct 12, 2024

[AUTOCUT] Gradle Check Flaky Test Report for SpecificClusterManagerNodesIT #15944

Closed

reta merged commit 55e98ed into opensearch-project:main Oct 14, 2024

reta added v3.0.0 Issues and PRs related to version 3.0.0 v2.18.0 Issues and PRs related to version 2.18.0 labels Oct 14, 2024

opensearch-trigger-bot Bot added the backport-failed label Oct 14, 2024

gaobinlong mentioned this pull request Oct 14, 2024

[Backport 2.x] Fix multi-search with template doesn't return status code (#16265) #16312

Merged

3 tasks

opensearch-ci-bot mentioned this pull request Oct 14, 2024

[AUTOCUT] Gradle Check Flaky Test Report for IndexRecoveryIT #16319

Closed

BrewTestBot mentioned this pull request Nov 6, 2024

opensearch 2.18.0 Homebrew/homebrew-core#196785

Merged

junqiu-lei mentioned this pull request Jul 29, 2025

Fix search template response to include ext field from response #18865

Closed

3 tasks

tkykenmt mentioned this pull request Jan 9, 2026

docs: add multi-search-api report for v2.18.0 tkykenmt/opensearch-feature-explorer#735

Merged

Conversation

gaobinlong commented Oct 10, 2024

Description

Related Issues

Check List

Uh oh!

github-actions Bot commented Oct 10, 2024

Uh oh!

Uh oh!

reta commented Oct 11, 2024

Uh oh!

reta commented Oct 12, 2024

Uh oh!

github-actions Bot commented Oct 12, 2024

Uh oh!

gaobinlong commented Oct 12, 2024

Uh oh!

reta commented Oct 12, 2024

Uh oh!

github-actions Bot commented Oct 14, 2024

Uh oh!

dbwiddis commented Oct 14, 2024

Uh oh!

github-actions Bot commented Oct 14, 2024

Uh oh!

github-actions Bot commented Oct 14, 2024

Uh oh!

codecov Bot commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

opensearch-trigger-bot Bot commented Oct 14, 2024

Uh oh!

reta commented Oct 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Oct 14, 2024 •

edited

Loading